widgets.brease.ListBox

Widget Description

short: Liste von Texten
de: Zeigt eine Liste, aus welcher der Benutzer Elemente auswählen kann
en: Displays a list from where the user can select items

Properties

name description category type defaultValue bindable readOnly required localizable editableBinding projectable cssProp (has no setter and getter in JS) groupRefId groupOrder nodeRefId (for linking node and value) deprecated typeRefId (for StyleReference) subtype (for MpComIdentReference)
dataProvider ItemCollection see Datatype Data ItemCollection [] true false false false false true
displaySettings Defines which elements are displayed on the widget Appearance brease.enum.DropDownDisplaySettings default false false false false false true
ellipsis If true, overflow of text is symbolized with an ellipsis. This option has no effect, if wordWrap = true. Behavior Boolean false false false false false false true
enable Initial option to enable widget. Behavior Boolean true true false false false false true
fitHeight2Items If true, the height will fit to the necessary height if the height oft the list is bigger If false, the list uses the configured height Behavior Boolean false false false false false false true
imageAlign Position of images relative to text Appearance brease.enum.ImagePosition left false false false false false true
imagePath Path to the images location (e.g. 'Media/images/'). Names of the images must be given like the index in the dataProvider (e.g. 0.png, 1.png, 2.png) Appearance DirectoryPath false false false false false true
itemHeight Height of every item in the List Appearance Integer 40 false false false false false true
multiLine If true, more than one line is possible. Text will wrap when necessary (wordWrap=true) or at line breaks (\n). If false, text will never wrap to the next line. The text continues on the same line. Behavior Boolean false false false false false false true
permissionOperate restricts operability to users, which have given roles Accessibility RoleCollection no defaultValue
defined		 false false false false false true
permissionView restricts visibility to users, which have given roles Accessibility RoleCollection no defaultValue
defined		 false false false false false true
selectedIndex Index of the selected item. The first item has index=0 Data UInteger 0 true false false false true true
selectedValue Value of the selected item Data String true false false false true true
style reference to a style for this widget type Appearance StyleReference default true false false false false true
tabIndex sets if a widget should have autofocus enabled (0), the order of the focus (>0), or if autofocus should be disabled (-1) Behavior Integer 0 false false false false false true
tooltip reference to a tooltip for a widget Appearance String false false false true false true
visible change visibility Behavior Boolean true true false false false false true
wordWrap If true, text will wrap when necessary. Behavior Boolean false false false false false false true
maxHeight maximum outer height of widget Size 0 false false false true true
minHeight minimum outer height of widget Size 0 false false false true true
maxWidth maximum outer width of widget Size 0 false false false true true
minWidth minimum outer width of widget Size 0 false false false true true
zIndex The zIndex property specifies the z-order of a widget and its childs.
When widgets overlap, z-order determines which one covers the other. A widget with a larger zIndex generally covers a widget with a lower one.
The zIndex must be unique within a content.
 UInteger no defaultValue
defined		 false false true true true
left absolute position measured from left boundary of parent container Integer no defaultValue
defined		 false false false true true
top absolute position measured from top boundary of parent container Integer no defaultValue
defined		 false false false true true
height outer height of widget Size 150 false false false true true
width outer width of widget Size 150 false false false true true

Styleable Properties

name type description defaultValue
borderWidth PixelValCollection

Sets the width of the border. For further information, please see its type

 2px
borderStyle BorderStyle

Sets the border style of the widget. For further information, please see its type

 solid
cornerRadius PixelValCollection

Sets the radius of the widget rounded corners. For further information, please see its type

 0px
borderColor ColorCollection

Sets the border color of the widget

 #535353
opacity Opacity

Opacity of the widget

 1
margin Margin

Margin of the Widget

 0px
padding Padding

Padding of the widget

 0px 15px
backColor Color

Sets the background color of the items not selected

 #FFFFFF
backGroundGradient Gradient

Sets the background color of the items not selected as a gradient
activeBackColor Color

Sets the background color of the selected item

 #ff8800
activeBackGroundGradient Gradient

Sets the background color of the selected item as a gradient
listSeparatorColor Color

Sets the color of the list separator

 #000
textColor Color

Sets the text color of the items not selected

 #535353
activeTextColor Color

Sets the text color of the selected item

 #ffffff
textAlign brease.enum.TextAlign

Alignment of the text

 center
fontSize PixelVal

Fontsize of the text in pixel

 12px
fontName FontName

Fontname of the text

 Arial
bold Boolean

If true font style is bold

 true
italic Boolean

If true font style is italic

 false

Events

name description arguments
Click Fired when element is clicked on.
  • origin: String

    id of widget that triggered this event

  • horizontalPos: String

    horizontal position of click in pixel i.e '10px'

  • verticalPos: String

    vertical position of click in pixel i.e '10px'

DisabledClick Fired when disabled element is clicked on.
  • origin: String

    id of widget that triggered this event

  • hasPermission: Boolean

    defines if the state is caused due to missing roles of the current user

  • horizontalPos: String

    horizontal position of click in pixel i.e '10px'

  • verticalPos: String

    vertical position of click in pixel i.e '10px'

EnableChanged Fired when operability of the widget changes.
  • value: Boolean

    operability

FocusIn Fired when the widgets gets focus
FocusOut Fired when the widgets lost focus
OnDragEnter Fired when element has onDragEnter.
  • contentId: String

    content id of the widget that has been entering the droppable widget

  • widgetId: String

    id of the widget that has been entering the droppable widget

OnDragLeave Fired when element has OnDragLeave.
  • contentId: String

    content id of the widget that has been leaving the droppable widget

  • widgetId: String

    id of the widget that has been leaving the droppable widget

OnDrop Fired when element has OnDrop.
  • contentId: String

    content id of the widget that has been dropped on the droppable widget

  • widgetId: String

    id of the widget that has been dropped on the droppable widget

SelectedIndexChanged Fired when index changes.
  • selectedIndex: Integer

  • selectedValue: String

VisibleChanged Fired when the visibility of the widget changes.
  • value: Boolean

    visibility

Actions

name description arguments result
Focus Sets focus on the widget element, if it can be focused and keyboardOperation=true
GetSelectedIndex Returns selectedIndex.
GetSelectedValue Returns selectedValue.
SetDataProvider Sets dataProvider
  • provider: ItemCollection

SetEnable Sets the state of property «enable»
  • value: Boolean

SetSelectedIndex Sets selectedIndex
  • index: Integer

SetSelectedValue Sets selectedValue
  • value: String

SetStyle
  • value: StyleReference

SetVisible Sets the state of property «visible»
  • value: Boolean

ShowTooltip